<!doctype html>


<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>observer.js (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>


  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>





<div class="colmask rightmenu">
<div class="colleft">
    <div class="col1">
      <!-- Column 1 start -->

<div id="title">
       <span class="fn">observer.js</span>
</div>

<div class="g-section g-tpl-75-25">
  <div class="g-unit g-first" id="description">
    Provide definition of an observer. This is meant to
 be used with <code>goog.labs.observe.Observable</code>.

 This file also provides convenient functions to compare and create
 Observer objects.
  </div>
  

        <div class="g-unit" id="useful-links">
          <div class="title">Useful links</div>
          <ol>
            <li><a href="closure_goog_labs_observe_observer.js.source.html"><span class='source-code-link'>Source Code</span></a></li>
            <li><a href="http://code.google.com/p/closure-library/source/browse/closure/goog/labs/observe/observer.js">Git</a></li>
          </ol>
        </div>
</div>

<h2 class="g-first">File Location</h2>
  <div class="g-section g-tpl-20-80">
    <div class="g-unit g-first">
      <div class="g-c-cell code-label">labs/observe/observer.js</div>
    </div>
  </div>
<hr/>


  <h2>Classes</h2>
 <div class="fn-constructor">
        <a href="interface_goog_labs_observe_Observer.html">
          goog.labs.observe.Observer</a><br/>
        <div class="class-details">A class implementing <code>Observer</code> may be informed of changes in
observable object.</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_labs_observe_Observer_FunctionObserver_.html">
          goog.labs.observe.Observer.FunctionObserver_</a><br/>
        <div class="class-details">An observer that calls the given function on <code>notify</code>.</div>
 </div>
      
<br/>

  <div class="legend">
        <span class="key publickey"></span><span>Public</span>
        <span class="key protectedkey"></span><span>Protected</span>
        <span class="key privatekey"></span><span>Private</span>
  </div>









<div class="section">
  <table class="horiz-rule">


  </table>
</div>




  <h2>Global Functions</h2>





<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.labs.observe.Observer.equals"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.labs.observe.Observer.</span><span class="entryName">equals<span class="args">(<span class="arg">observer1</span>,&nbsp;<span class="arg">observer2</span>)</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">observer1</span>
        : <div class="fullType"><span class="type"><a href="interface_goog_labs_observe_Observer.html">goog.labs.observe.Observer</a></span></div>
        <div class="entryOverview">Observer to compare.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">observer2</span>
        : <div class="fullType"><span class="type"><a href="interface_goog_labs_observe_Observer.html">goog.labs.observe.Observer</a></span></div>
        <div class="entryOverview">Observer to compare.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>&nbsp;
            Whether observer1 and observer2 are equal, as determined by the first observer1&amp;#39;s <code>equals</code> method.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_labs_observe_observer.js.source.html#line58">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.labs.observe.Observer.fromFunction"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.labs.observe.Observer.</span><span class="entryName">fromFunction<span class="args">(<span class="arg">fn</span>,&nbsp;<span class="arg">opt_scope</span>)</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="interface_goog_labs_observe_Observer.html">goog.labs.observe.Observer</a></span></div>
      </div>


     <div class="entryOverview">
       Creates an observer that calls the given function.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">fn</span>
        : <div class="fullType"><span>?</span><span class="type">function (goog.labs.observe.Notice): </span></div>
        <div class="entryOverview">Function to be converted.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_scope</span>
        : <div class="fullType">(<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span><span>&nbsp;|&nbsp;</span><span class="type">undefined</span>)</div>
        <div class="entryOverview">Optional scope to execute the function.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="interface_goog_labs_observe_Observer.html">goog.labs.observe.Observer</a></span></div>&nbsp;
            An observer object.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_labs_observe_observer.js.source.html#line69">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>






      <!-- Column 1 end -->
    </div>

        <div class="col2">
          <!-- Column 2 start -->
          <div class="col2-c">
            <h2 id="ref-head">Directory observe</h2>
            <div id="localView"></div>
          </div>

          <div class="col2-c">
            <h2 id="ref-head">File Reference</h2>
            <div id="sideFileIndex" rootPath="" current="labs/observe/observer.js"></div>
          </div>
          <!-- Column 2 end -->
        </div>
</div>
</div>

</body>
</html>
